|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.doclinx.jftr.DOCHIT
This class is a structure containing result information from a search. A DOCHIT is available for each location matching a query. A DOCHIT contains the document ID of the match along with the total number of matches in the document.
CatalogSearch
Field Summary | |
int |
docId
Document ID #. |
int |
hitCount
Number of hits OR the relevancy metric for the document |
Constructor Summary | |
DOCHIT(com.doclinx.jftr.DOCHIT dh)
Copy constructor to initialize class object. |
|
DOCHIT(com.doclinx.jftr.DOCHIT dh,
int docIdOffset)
Copy constructor to initialize class object and bias doc ID. |
|
DOCHIT(int d,
int h)
Constructor to initialize class object. |
|
DOCHIT(int d,
int h,
int docIdOffset)
Constructor to initialize class object and bias doc ID. |
|
DOCHIT(com.doclinx.jftr.PTR ptr)
Create DOCHIT from PTR object |
Method Summary | |
boolean |
equals(com.doclinx.jftr.DOCHIT dh)
|
byte[] |
getAsMem()
|
int |
getDocument()
Gets Document ID from DOCHIT object. |
int |
getHitCount()
Return hit count information from DOCHIT object. |
int |
getRelevancy()
Return relevancy information from DOCHIT object. |
static int |
sizeof()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public int docId
public int hitCount
Constructor Detail |
public DOCHIT(int d, int h)
d
- Document ID.h
- Hit count.public DOCHIT(com.doclinx.jftr.DOCHIT dh, int docIdOffset)
dh
- DOCHIT to copy.docIdOffset
- Offset to add to document ID.public DOCHIT(int d, int h, int docIdOffset)
d
- Document ID.h
- Hit count.docIdOffset
- Offset to add to document ID.public DOCHIT(com.doclinx.jftr.DOCHIT dh)
dh
- DOCHIT to copy.public DOCHIT(com.doclinx.jftr.PTR ptr)
ptr
- PTR object (bytes)Method Detail |
public int getRelevancy()
public int getHitCount()
public int getDocument()
public byte[] getAsMem()
public boolean equals(com.doclinx.jftr.DOCHIT dh)
public static int sizeof()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |